PT-2368 - refactor all tools cli#1096
Open
BON4 wants to merge 7 commits into
Open
Conversation
This change intorduces refactoring of all tools to work with new config implementation.
svetasmirnova
requested changes
Mar 31, 2026
svetasmirnova
left a comment
svetasmirnova
left a comment
Collaborator
There was a problem hiding this comment.
Please finish the merge of 3.x and resolve conflicts: pt-k8s-debug-collector tests fail.
svetasmirnova
requested changes
Mar 31, 2026
svetasmirnova
left a comment
svetasmirnova
left a comment
Collaborator
There was a problem hiding this comment.
pt-mongodb-summary test also fails. Looks like another conflict issue:
=== RUN TestGetMongosInfo
main_test.go:296:
Error Trace: /home/sveta/src/percona/percona-toolkit/src/go/pt-mongodb-summary/main_test.go:296
Error: Should not be: 0
Test: TestGetMongosInfo
--- FAIL: TestGetMongosInfo (0.00s)
Collaborator
This is not right. |
svetasmirnova
approved these changes
Apr 2, 2026
svetasmirnova
requested changes
Apr 2, 2026
artemgavrilov
requested changes
Jun 4, 2026
Comment on lines
+52
to
+56
| Encrypt bool `name:"collect" negatable:"" default:"true"` | ||
| Sanitize bool `name:"sanitize" negatable:"" default:"true"` | ||
| SanitizeHostnames bool `name:"encrypt" negatable:"" default:"true"` | ||
| SanitizeQueries bool `name:"sanitize-hostnames" negatable:"" default:"true"` | ||
| Collect bool `name:"sanitize-queries" negatable:"" default:"true"` |
Contributor
There was a problem hiding this comment.
There is a mess between field names and tags.
Comment on lines
+86
to
+88
| for _, incDir := range c.IncludeDirs { | ||
| incDir = expandHomeDir(incDir) | ||
| } |
Contributor
There was a problem hiding this comment.
You just throwing away modified incDir here, c.IncludeDirs stays unmodified.
Comment on lines
-125
to
-130
| if _, err = os.Stat(*opts.TempDir); os.IsNotExist(err) { | ||
| log.Infof("Creating temporary directory: %s", *opts.TempDir) | ||
| if err = os.Mkdir(*opts.TempDir, os.ModePerm); err != nil { | ||
| log.Fatalf("Cannot create temporary dirextory %q: %s", *opts.TempDir, err) | ||
| } | ||
| } |
Contributor
There was a problem hiding this comment.
Shouldn't we still create temp dir?
Comment on lines
-135
to
-138
| if !*opts.NoRemoveTempFiles { | ||
| if err = removeTempFiles(*opts.TempDir, !*opts.NoEncrypt); err != nil { | ||
| log.Fatal(err) | ||
| } |
Contributor
There was a problem hiding this comment.
It seems that this functionality was missed. Temporary files never deleted and --remove-temp-files flag does nothing.
| toolname, Version, Build, GoVersion, Commit, | ||
| ), | ||
| }, | ||
| ) //TODO fix help |
Contributor
There was a problem hiding this comment.
What's wrong with the help?
| ) | ||
|
|
||
| var ( | ||
| CLI = &cliOptions{} |
Contributor
There was a problem hiding this comment.
I would suggest to
Suggested change
| CLI = &cliOptions{} | |
| CLI cliOptions |
And later refer it as &CLI
| decryptCmd = "decrypt" | ||
| encryptCmd = "encrypt" | ||
| collectCmd = "collect" | ||
| sanitizeCmd = "sanitize" |
Contributor
There was a problem hiding this comment.
Some of these are unused
Comment on lines
+105
to
+107
| if args.Version { | ||
| return | ||
| } |
Contributor
There was a problem hiding this comment.
It seems that this is redundant. Kong exits automatically for version flag.
Comment on lines
181
to
+187
| ``--skip-pod-summary`` | ||
| Skip the collection of pod-specific summary data. | ||
|
|
||
| ``--skip-pod-summary`` | ||
|
|
||
| Skip pod summary collection. | ||
|
|
Co-authored-by: Artem Gavrilov <artem.gavrilov@percona.com>
Co-authored-by: Sveta Smirnova <svetasmirnova@users.noreply.github.com>
Co-authored-by: Sveta Smirnova <svetasmirnova@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR migrates CLI/config handling to the new Kong-based configuration layer across all affected Go tools.
The goal is to standardize flag parsing, config-file behavior, password prompts, and version/version-check flow using shared config primitives.
Changes
kong.VersionFlaginlib/config/commonFlags.go.config.Setup(...)in:pt-mongodb-index-checkpt-mongodb-query-digestpt-mongodb-summarypt-pg-summarypt-secure-collectgetopt/kingpin) with Kong struct tags and hooks (AfterApply, commandRunmethods).config.VersionCheckFlag+versioncheck.CheckUpdates(...).config.StdinRequestStringfor DB/encryption passwords.pt-secure-collectsubcommands (collect,encrypt,decrypt,sanitize) to command structs with explicit validation and runtime handlers.Notes
This is primarily a CLI/config refactor; no intended functional changes in business logic.
Main expected impact is behavior consistency across tools (flags, defaults, help/version output, password prompts).
The contributed code is licensed under GPL v2.0
Contributor Licence Agreement (CLA) is signed
util/update-modules has been ran
Documentation updated
Test suite update